home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 21 / Cream of the Crop 21 (Terry Blount) (October 1996).iso / windows / lwed223.zip / README.TXT < prev   
Text File  |  1996-09-01  |  9KB  |  235 lines
  1.  
  2. LWed - Windows INI file editor.
  3.  
  4. Version 2.2.3 of 1996-09-01, Copyright 1996 (C) Laszlo Radanyi
  5.  
  6. TABLE OF CONTENTS____________________________________________________________
  7.  
  8. 1. LICENSE AGREEMENT                            
  9.  
  10. 2. INTRODUCTION
  11.  
  12. 3. USER'S MANUAL
  13.    3.1 Basic functions
  14.    3.2 Advanced functions
  15.    3.3 The built-in help
  16.  
  17. 4. ABOUT THE AUTHOR
  18.  
  19.  
  20. 1. LICENSE ISSUES____________________________________________________________
  21.  
  22. This version of LWED is distributed as SHAREWARE.  You may use the
  23. program  unlimitedly for 21 days  at which time you have to decide 
  24. to eighter discard the program or register it. You  are encouraged
  25. to distribute the  unregistered  version  of  LWED as  long as the
  26. package is not modified.
  27.  
  28. The  registration  fee is 5 USD, which is best sent via snail mail
  29. after contacting the author via email.
  30.  
  31. By registering LWED, you gain a single user license to the product
  32. and  you help the author to make even better products.  Registered
  33. users  also have life-time support for the product via email.  All
  34. registered users have right to all new versions of lwed as long as
  35. the license is valid.
  36.  
  37. Upon  registering,  the  user receives a registered version of the 
  38. program which has different license conditions.
  39.  
  40. THIS PROGRAM  IS DISTRIBUTED  IN THE HOPE THAT IT  WILL BE USEFUL,
  41. BUT  WITHOUT  ANY WARRANTY;  WITHOUT  EVEN THE IMPLIED WARRANTY OF
  42. MERCHANTIBILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  43.  
  44. THE  USER  SHOULD  BE  AWARE  OF  THE  RISKS  OF  MANIPULATING THE
  45. WINDOWS  INITIALIZATION  FILES. CARELESS CHANGES TO SOME INI FILES
  46. MAY  RENDER THE SYSTEM  UNUSABLE.  THE  AUTHOR OF  LWED ACCEPTS NO
  47. RESPONSIBILITY  FOR  ANY  LOSS OF  FUNCTIONALITY  OR  LOSS OF DATA
  48. AS RESULT OF THE USE OF THIS PRODUCT.
  49.        
  50. Windows is the registrated trademark of Microsoft Corporation.
  51. 4DOS is owned by JP software Inc.
  52.  
  53. 1. INTRODUCTION______________________________________________________________
  54.  
  55. Lwed is a  utility for  manipulating  Windows(TM)  INI files from
  56. DOS. Its  history is simple;  its function may be simple too, but
  57. over the years,  LWED  has grown to be able to  do most of what a
  58. power user should want from a program of this kind.
  59.  
  60. The program is  started with a flag for the desired operation and
  61. parameters  for this  operation.   Each action has a more or less 
  62. verbose name,  which  may make them  easier to remember.  Most of
  63. the functions have a shorter, one character name too.
  64.  
  65. There is a  built-in help system, which is kept simple;  the most
  66. used  functions  are  shown  on one side  and  the more  advanced
  67. operations are described on a second page  while a  few functions
  68. that  do  not manipulate INI files are described on a third page.
  69. Clearly, there are so many  functions, that it  would have impos-
  70. sible to  squeeze  together descriptions  for  all of them on one
  71. page.  This  is  why I  made  pages,  but it was too technocratic
  72. to call them page '1' through '3'.
  73.  
  74. Rather than  writing a command for  changing  one value at a time
  75. in  an INI file, LWED can MERGE two INI files. This is  done in a
  76. somewhat unintelligent way; see the section about '--merge'.
  77.  
  78. You  are  very  welcome with  comments  about  this program; I am 
  79. particulary  interested in  comments  about how  the program fits
  80. different needs. 
  81.  
  82. Although there are a lot of other INI file manipulating utilities
  83. on the Internet, I sincerely believe that this is THE one you
  84. need.
  85.  
  86.  
  87. 3. USER'S MANUAL_____________________________________________________________
  88.  
  89. LWED is a  DOS  command-line mode program, and it is  aimed at batch use
  90. that is, it needs command-line arguments to complete a function.
  91.  
  92. Switches - or modes - can be forward slashes  '/'  which is  very common
  93. under DOS,   and  you can  also  use  a  dash  '-'.  You need two switch 
  94. characters for a verbose switch, like  '--' or '//'.  Any other switches
  95. or switch combinations will cause LWED to exit and leave a short message
  96. on the standard error stream.
  97.  
  98. The arguments used by the program are referenced between less-than and
  99. greater-than signs. The names used are as follows:
  100.  
  101. <ini file name>    The target INI file name. If this file is in the
  102.                    same directory as LWED, only the file name is 
  103.                    necessary, otherwise the full path needs to be
  104.                    given.
  105. <section>          The target section, that is, the INI value
  106.                    starting after a string enclosed in brackets as
  107.                    in [section] and until the next such section
  108.                    name is encountered.
  109. <key>              The string before the first equal sign on one line
  110.                    in the given section.
  111. <value>            The string after the first equal sign on one line
  112.                    in the given section.
  113. <variable>         The name of the environment variable to use for
  114.                    the '-e' function.
  115.                      
  116. 3.1 Basic functions__________________________________________________________
  117.  
  118. The basic functions are the most used or oldest functions; they are
  119. probably what you would expect from a program like this.
  120.  
  121. -h or --help
  122.     This launches the built-in help system. Read more about it in 
  123.     section 3.3.
  124.     
  125. -v or --version
  126.     Prints version information along with registration data to the
  127.     standard output stream.  The version information  is necessary 
  128.     when communicating with the author.  This can also help you to
  129.     see if there is a newer version  distributed.  Newer  versions
  130.     are  generally  better  since  the  reported  bugs  are always
  131.     corrected before new functionality is added.
  132.     
  133. -r or --read
  134.     Prints <value> of <key> to the standard output stream.
  135.  
  136. -w or --write
  137.     Changes an existing <key> <value> as specified; if the key doesn't 
  138.     exist, a new key is created.
  139.      
  140. -a or --append
  141.     Appends <value> to the current value of <key>. If the key doesn't
  142.     exist, a new key is created. 
  143.  
  144. -i or --insert
  145.    or --prepend
  146.     Inserts <value> immediately after the equal sign '=' of <key>. If
  147.     the key doesn't exist, a new key is created.
  148.  
  149. -d or --delete
  150.     Removes <key> from <section>.
  151.     
  152. -m or --merge
  153.    Writes the contents of <source file> into <target file> just as you
  154.    would write value for value. Please pay attention to that MERGE does
  155.    NOT handle SYSTEM.INI/[386Enh] very well,  since it uses standard
  156.    INI write operations; that is, for each [section], for each key
  157.    in the source file, it writes [Section]/key=value into the target
  158.    file. This means that the first device= statement could be over
  159.    written several times !
  160.  
  161. -e or --read_to_environment
  162.    Reads <value> into <variable> in the master environment. If the
  163.    variable is not set, a new is written. WARNING: This function
  164.    relies on Int2E. 4DOS users should be particulary careful with 
  165.    this function, see the 4DOS manual for more information.
  166.  
  167. 3.2 Advanced functions_______________________________________________________
  168.  
  169. -c or --comment
  170.     Inserts a comment character ';' before the entry.
  171.     
  172. -q or --write_quoted
  173.     Writes <value> inside of double quotes. For example :
  174.     
  175.     LWED -q TEST.INI section key quotedValue
  176.     
  177.     results in the following entry written into the file
  178.     TEST.INI in the same directory as LWED.EXE:
  179.     
  180.     [section]
  181.     key="quoted value"
  182.  
  183. --write_blind
  184.     Writes <key>=<value> as first entry in <section> without
  185.     search for an already existing value.
  186.    
  187. --write_pair
  188.     Searches for <key>=<value> under <section> and creates the
  189.     key if it doesn't exist. This is essentially the same 
  190.     function as write, but this one also looks for the supplied
  191.     value.
  192.     ** NOTE **
  193.     The pair functions all are primarily intended to deal with
  194.     the [386Enh] section in SYSTEM.INI, since this section 
  195.     contains a lot of keys named 'device' but different values.
  196.     
  197. --comment_pair
  198.     Searches for <key>=<value> under <section> and places a
  199.     comment character before the key. This is the same function
  200.     as 'write_comme